project-name

project-name

Get the name of a project, from package.json, git config, or basename of the current working directory.

Install

Install with npm:

$ npm install --save project-name

Usage

The project name is resolved in this order:

1. check for package.json, if exists name is returned
2. check for git repository, if exists return repository name
3. use the path.basename of the current working directory

var name = require('project-name');
name();
//=> project-name

Optionally specify a current working directory:

var name = require('project-name');
name('foo');

Related projects

You might also be interested in these projects:

• git-repo-name: Get the repository name from the git remote origin URL. | homepage
• git-user-email: Get the email address of the current user from git config. | homepage
• git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
• git-username: Get the username from a git remote origin URL. | homepage

Contributing

This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.

Building docs

(This document was generated by verb-readme-generator (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on July 13, 2016.